<html>
  <head>
    <title>Getting Herbgrind</title>
    <link rel="stylesheet" type="text/css" href="main.css">
    <meta name="viewport" content="width=device-width, initial-scale=1"/>
  </head> 
    <h4>From the team that brought you <a href="http://herbie.uwplse.org"><img src="http://herbie.uwplse.org/logo.png" align="middle" style="width:10%"></a></h4>
    <h1>Herbgrind</h1>
  <a href="http://uwplse.github.io/herbgrind/">
    <img src="logo.jpg" style="display: block; margin: 0 auto; width:50%">
  </a>

    <h2>Getting Herbgrind</h2>
    <p class="bodytext"> We don't have any binary builds available,
      but it should be easy to install it. Herbgrind currently
      primarily supports 64-bit Linux, but 32-bit might also work, and
      theres some work in progress to also support OSX.</p>

  <p class="bodytext"> Installing Herbgrind requires that you have
    the <a href="https://gcc.gnu.org/install/">GNU C Compiler</a>,
    <a href="https://www.gnu.org/software/m4/m4.html">M4</a>,
    <a href="https://www.gnu.org/software/automake/">Automake 1.15</a>,
    <a href="https://www.gnu.org/software/autoconf/">Autoconf</a>,
    <a href="https://www.python.org/downloads/">Python 3</a>,
    <a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git</a>, and
    <a href="http://svnbook.red-bean.com/en/1.7/svn.intro.install.html">Subversion</a>
    installed. The first five are probably already installed on your
    Linux installation, and if not should be available in your package
    manager, although some older builds might not have a new enough
    version of Automake.</p>

    <p class="bodytext"> Herbgrind also builds
      on <a href="http://valgrind.org">Valgrind</a>, <a href="https://gmplib.org/">GMP</a>, <a href="http://www.mpfr.org/">GNU
      MPFR</a>, and <a href="http://openlibm.org/">OpenLibm</a>, but
      these are included in the release and don't need to be
      separately downloaded.</p>

    <p class="bodytext"> Once you have the prerequisites installed, you can run:</p>
    <pre>git clone https://github.com/uwplse/herbgrind.git</pre>
    <p class="bodytext"> to download the source code, and put it in a directory called
    "herbgrind" in the current working directory. From there, you
      should just be able to run:</p>
    <pre>cd hergrind; make</pre>
    <p class="bodytext"> to build it, and </p>
    <pre> <i>herbgrind-path</i>/valgrind/herbgrind-install/bin/valgrind --tool=herbgrind <i>path-to-client-binary</i></pre>
    <p class="bodytext"> to run it. Please <a href="mailto:alexss@eng.ucsd.edu">email
        me</a> with any problems you have.</p>
    <p class="bodytext"> You can get find out more about Herbgrind's various options by running</p>
    <pre> <i>herbgrind-path</i>/valgrind/herbgrind-install/bin/valgrind --tool=herbgrind --help</pre>
    <p class="bodytext"> and </p>
    <pre> <i>herbgrind-path</i>/valgrind/herbgrind-install/bin/valgrind --tool=herbgrind --debug-help</pre>
</html>
